/*
 * Copyright (c) 2013, SRI International
 * All rights reserved.
 * Licensed under the The BSD 3-Clause License;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 * 
 * http://opensource.org/licenses/BSD-3-Clause
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the aic-util nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.sri.ai.util.collect;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.util.Iterator;

import com.google.common.annotations.Beta;

/**
 * An iterator ranging over lines entered on the console. Properties prompt and
 * ender can be set, defining which prompt appears, and which string ends the
 * iterator.
 * 
 * @author braz
 */
@Beta
public class ConsoleIterator implements Iterator<String> {

	private BufferedReader console = new BufferedReader(new InputStreamReader(System.in));

	private String prompt = "> ";
	private String ender = "end";
	private String answer;

	public ConsoleIterator() {
	}

	public ConsoleIterator(String prompt, String ender) {
		this.prompt = prompt;
		this.ender = ender;
	}

	public boolean hasNext() {
		try {
			System.out.print(prompt);
			String reply = console.readLine();
			if (reply.equals(ender)) {
				return false;
			}
			answer = reply;
		}
		catch (java.io.IOException e) {
			System.err.println(e);
		}
		return true;
	}

	public String next() {
		return answer;
	}

	/** Returns next() cast to String. */
	public String nextString() {
		return answer;
	}

	/**
	 * Gives access to current string without iterating.
	 */
	public String currentString() {
		return answer;
	}

	public void remove() throws UnsupportedOperationException {
		throw new UnsupportedOperationException();
	}

	public String getPrompt() {
		return prompt;
	}

	public void setPrompt(String prompt) {
		this.prompt = prompt;
	}

	public String getEnder() {
		return ender;
	}

	public void setEnder(String ender) {
		this.ender = ender;
	}
}
